com.inscoper.nbo.FreeBeam

Represents the XML element FreeBeam. More...

Inherits from com.inscoper.nbo.LightSourceCoupling_Type, com.inscoper.nbo.ManufacturerSpec_Type, com.inscoper.nbo.NBOBaseClass

Public Functions

	Name
synchronized void	delete()
	FreeBeam()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path, boolean validate) Populates this object from a JSON file.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string, boolean validate) Populates this object from a JSON string.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path, boolean validate) Populates this object from a XML file.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string, boolean validate) Populates this object from a XML string.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename, boolean validate) Serializes this object to an XML file.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString(boolean validate) Serializes this object to an XML string.
String	toXmlString() Serializes this object to an XML string.
void	setDirectMount(boolean value, boolean validate) Sets the value of the DirectMount attribute.
void	setDirectMount(boolean value) Sets the value of the DirectMount attribute.
boolean	getDirectMount() Returns the value of the DirectMount attribute.
void	resetDirectMount() Resets the DirectMount attribute to an unset state.
boolean	hasDirectMount() Checks whether the DirectMount attribute is present.
void	setMountType(String value, boolean validate) Sets the value of the MountType attribute.
void	setMountType(String value) Sets the value of the MountType attribute.
String	getMountType() Returns the value of the MountType attribute.
void	resetMountType() Resets the MountType attribute to an unset state.
boolean	hasMountType() Checks whether the MountType attribute is present.
FreeBeam	__internal_create(long cPtr, boolean own)
FreeBeam	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a CMOS.
StringSet	getMountTypeAllowedValues() Returns the allowed values for this attribut.

Protected Functions

	Name
	FreeBeam(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(FreeBeam obj)

Additional inherited members

Public Functions inherited from com.inscoper.nbo.LightSourceCoupling_Type

	Name
	LightSourceCoupling_Type()
void	setID(LightSourceCouplingID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(LightSourceCouplingID_Type value) Sets the value of the ID attribute.
LightSourceCouplingID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setName(Denomination_Type value, boolean validate) Sets the value of the Name attribute.
void	setName(Denomination_Type value) Sets the value of the Name attribute.
Denomination_Type	getName() Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
boolean	hasName() Checks whether the optional Name attribute is present.
void	setAttenuation(float value, boolean validate) Sets the value of the Attenuation attribute.
void	setAttenuation(float value) Sets the value of the Attenuation attribute.
float	getAttenuation() Returns the value of the Attenuation attribute.
void	resetAttenuation() Resets the Attenuation attribute to an unset state.
boolean	hasAttenuation() Checks whether the Attenuation attribute is present.
void	setTransmittance(float value, boolean validate) Sets the value of the Transmittance attribute.
void	setTransmittance(float value) Sets the value of the Transmittance attribute.
float	getTransmittance() Returns the value of the Transmittance attribute.
void	resetTransmittance() Resets the Transmittance attribute to an unset state.
boolean	hasTransmittance() Checks whether the Transmittance attribute is present.
void	setCouplingLensRef(LensRef_Type value, boolean validate) Sets the value of the CouplingLensRef element.
void	setCouplingLensRef(LensRef_Type value) Sets the value of the CouplingLensRef element.
LensRef_Type	getCouplingLensRef() Returns the value of the CouplingLensRef element.
void	resetCouplingLensRef() Resets the CouplingLensRef element to an unset state.
boolean	hasCouplingLensRef() Checks whether the optional CouplingLensRef element is present.
void	setAnnotationRef(LightSourceCoupling_Type_InlineAnnotationRef value, boolean validate) Sets the value of the AnnotationRef element.
void	setAnnotationRef(LightSourceCoupling_Type_InlineAnnotationRef value) Sets the value of the AnnotationRef element.
LightSourceCoupling_Type_InlineAnnotationRef	getAnnotationRef() Returns the value of the AnnotationRef element.
void	resetAnnotationRef() Resets the AnnotationRef element to an unset state.
boolean	hasAnnotationRef() Checks whether the optional AnnotationRef element is present.

Protected Functions inherited from com.inscoper.nbo.LightSourceCoupling_Type

	Name
	LightSourceCoupling_Type(long cPtr, boolean cMemoryOwn)

Public Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type()
void	setManufacturer(String value, boolean validate) Sets the value of the Manufacturer attribute.
void	setManufacturer(String value) Sets the value of the Manufacturer attribute.
String	getManufacturer() Returns the value of the Manufacturer attribute.
void	resetManufacturer() Resets the Manufacturer attribute to an unset state.
boolean	hasManufacturer() Checks whether the Manufacturer attribute is present.
void	setModel(String value, boolean validate) Sets the value of the Model attribute.
void	setModel(String value) Sets the value of the Model attribute.
String	getModel() Returns the value of the Model attribute.
void	resetModel() Resets the Model attribute to an unset state.
boolean	hasModel() Checks whether the Model attribute is present.
void	setCatalogNumber(String value, boolean validate) Sets the value of the CatalogNumber attribute.
void	setCatalogNumber(String value) Sets the value of the CatalogNumber attribute.
String	getCatalogNumber() Returns the value of the CatalogNumber attribute.
void	resetCatalogNumber() Resets the CatalogNumber attribute to an unset state.
boolean	hasCatalogNumber() Checks whether the CatalogNumber attribute is present.
void	setLotNumber(String value, boolean validate) Sets the value of the LotNumber attribute.
void	setLotNumber(String value) Sets the value of the LotNumber attribute.
String	getLotNumber() Returns the value of the LotNumber attribute.
void	resetLotNumber() Resets the LotNumber attribute to an unset state.
boolean	hasLotNumber() Checks whether the LotNumber attribute is present.
void	setMapAnnotation_List(MapAnnotationVector value, boolean validate) Sets the list of MapAnnotation elements.
void	setMapAnnotation_List(MapAnnotationVector value) Sets the list of MapAnnotation elements.
MapAnnotationVector	getMapAnnotation_List() Returns the list of MapAnnotation elements.
void	addToMapAnnotation_List(MapAnnotation value, boolean validate) Adds a new MapAnnotation element to this object.
void	addToMapAnnotation_List(MapAnnotation value) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
void	setSpecsFile(FileAnnotation_Type value, boolean validate) Sets the value of the SpecsFile element.
void	setSpecsFile(FileAnnotation_Type value) Sets the value of the SpecsFile element.
FileAnnotation_Type	getSpecsFile() Returns the value of the SpecsFile element.
void	resetSpecsFile() Resets the SpecsFile element to an unset state.
boolean	hasSpecsFile() Checks whether the optional SpecsFile element is present.
void	setAdditionalVendorInformation_List(AdditionalVendorInformationVector value, boolean validate) Sets the list of AdditionalVendorInformation elements.
void	setAdditionalVendorInformation_List(AdditionalVendorInformationVector value) Sets the list of AdditionalVendorInformation elements.
AdditionalVendorInformationVector	getAdditionalVendorInformation_List() Returns the list of AdditionalVendorInformation elements.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value, boolean validate) Adds a new AdditionalVendorInformation element to this object.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.
StringSet	getManufacturerAllowedValues() Returns the allowed values for this attribut.
StringSet	getModelAllowedValues() Returns the allowed values for this attribut.
StringSet	getCatalogNumberAllowedValues() Returns the allowed values for this attribut.
StringSet	getLotNumberAllowedValues() Returns the allowed values for this attribut.

Protected Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description

public class com.inscoper.nbo.FreeBeam;

Represents the XML element FreeBeam.

A Free Beam coupling between the Light Source and the Microscope Stand consists of either a direct mount or an optical path that directs light across free space to the back of the Microscope Stand.

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.delete

function FreeBeam

public FreeBeam()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.getTypeName

function getXMLName

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.getXMLName

function getNBOType

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.getNBOType

function getChildren

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.getChildren

function getSubElements

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.getSubElements

function fromJsonFile

public void fromJsonFile(
    String path,
    boolean validate
)

Populates this object from a JSON file.

Parameters:

• path The path to the JSON file
• validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.fromJsonFile

function fromJsonFile

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

• path The path to the JSON file

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.fromJsonFile

function fromJsonString

public void fromJsonString(
    String json_string,
    boolean validate
)

Populates this object from a JSON string.

Parameters:

• json_string The JSON content as a string
• validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.fromJsonString

function fromJsonString

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

• json_string The JSON content as a string

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.fromJsonString

function fromXmlFile

public void fromXmlFile(
    String path,
    boolean validate
)

Populates this object from a XML file.

Parameters:

• path The path to the XML file
• validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.fromXmlFile

function fromXmlFile

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

• path The path to the XML file

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.fromXmlFile

function fromXmlString

public void fromXmlString(
    String xml_string,
    boolean validate
)

Populates this object from a XML string.

Parameters:

• xml_string The XML content as a string
• validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.fromXmlString

function fromXmlString

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

• xml_string The XML content as a string

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.fromXmlString

function toXmlFile

public void toXmlFile(
    String filename,
    boolean validate
)

Serializes this object to an XML file.

Parameters:

• filename The path to the output XML file
• validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.toXmlFile

function toXmlFile

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

• filename The path to the output XML file

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.toXmlFile

function toXmlString

public String toXmlString(
    boolean validate
)

Serializes this object to an XML string.

Parameters:

• validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.toXmlString

function toXmlString

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.toXmlString

function setDirectMount

public void setDirectMount(
    boolean value,
    boolean validate
)

Sets the value of the DirectMount attribute.

Parameters:

• value The value to set
• validate If true, validates constraints on value. Default is true.

Whether light traveling via this Light Source Coupling device from the Light Source to the Microscope Stand travels via a direct mount attached to the Microscope Stand (True), or across an optical path through the air (False).

function setDirectMount

public void setDirectMount(
    boolean value
)

Sets the value of the DirectMount attribute.

Parameters:

• value The value to set

Whether light traveling via this Light Source Coupling device from the Light Source to the Microscope Stand travels via a direct mount attached to the Microscope Stand (True), or across an optical path through the air (False).

function getDirectMount

public boolean getDirectMount()

Returns the value of the DirectMount attribute.

Return: The value of the attribute

Whether light traveling via this Light Source Coupling device from the Light Source to the Microscope Stand travels via a direct mount attached to the Microscope Stand (True), or across an optical path through the air (False).

function resetDirectMount

public void resetDirectMount()

Resets the DirectMount attribute to an unset state.

Whether light traveling via this Light Source Coupling device from the Light Source to the Microscope Stand travels via a direct mount attached to the Microscope Stand (True), or across an optical path through the air (False).

function hasDirectMount

public boolean hasDirectMount()

Checks whether the DirectMount attribute is present.

Return: true if the attribute has been set, false otherwise

Whether light traveling via this Light Source Coupling device from the Light Source to the Microscope Stand travels via a direct mount attached to the Microscope Stand (True), or across an optical path through the air (False).

function setMountType

public void setMountType(
    String value,
    boolean validate
)

Sets the value of the MountType attribute.

Parameters:

• value The value to set
• validate If true, validates constraints on value. Default is true.

In case the DirectMount field is True, this field records the type of Direct Mount utilized to couple the Light Source to this Microscope Stand.

function setMountType

public void setMountType(
    String value
)

Sets the value of the MountType attribute.

Parameters:

• value The value to set

In case the DirectMount field is True, this field records the type of Direct Mount utilized to couple the Light Source to this Microscope Stand.

function getMountType

public String getMountType()

Returns the value of the MountType attribute.

Return: The value of the attribute

In case the DirectMount field is True, this field records the type of Direct Mount utilized to couple the Light Source to this Microscope Stand.

function resetMountType

public void resetMountType()

Resets the MountType attribute to an unset state.

In case the DirectMount field is True, this field records the type of Direct Mount utilized to couple the Light Source to this Microscope Stand.

function hasMountType

public boolean hasMountType()

Checks whether the MountType attribute is present.

Return: true if the attribute has been set, false otherwise

In case the DirectMount field is True, this field records the type of Direct Mount utilized to couple the Light Source to this Microscope Stand.

function __internal_create

public static FreeBeam __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.__internal_create

function fromBase

public static FreeBeam fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a CMOS.

Parameters:

• base The base class to cast

Return: The casted element, or nullptr if the cast fails

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.fromBase

function getMountTypeAllowedValues

public static StringSet getMountTypeAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

In case the DirectMount field is True, this field records the type of Direct Mount utilized to couple the Light Source to this Microscope Stand.

Protected Functions Documentation

function FreeBeam

protected FreeBeam(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.nbo.LightSourceCoupling_Type.finalize

function getCPtr

protected static long getCPtr(
    FreeBeam obj
)

---

Updated on 2026-06-22 at 17:06:25 +0200